home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / telecomm / fido / filefind.lzh / FileFind / FileFind.doc < prev    next >
Encoding:
Text File  |  1995-01-02  |  15.2 KB  |  371 lines

  1.      Program: FileFind
  2.      Versoin: 2.0
  3.         Date: 1-1-1995
  4.  
  5.       Author: Glenn J. Schworak
  6.               (503) 399-7518   (Weekends and after 5pm Pacific time)
  7.               1710 Lee St SE -*- Salem, OR 97302
  8.  
  9.          BBS: Glenn's World
  10.               (503) 581-6524         (FidoNet 1:3406/32)
  11.               >>> You can FREQ many files from here! <<<
  12.  
  13.    ShareWare: $10.00
  14.  
  15.      Purpose: Access messages in FidoNet type networks where file searching
  16.               is preformed. Such as the echo FILEFIND on the Fido BackBone.
  17.  
  18. ------------------------------------------------------------------------------
  19. Thanks to those who have helped me test this program on various BBS systems
  20.  
  21.                  DLG - Rick Lembree     @  1:326/209 on FidoNet
  22.               Falcon - Roy Smith        @  1:375/402 on FidoNet
  23.                   E! - Stace Cunningham @  1:3604/60 on FidoNet
  24.                 CNet - Robert Scott     @ 71:1100/1  on LightNet
  25.  
  26. ------------------------------------------------------------------------------
  27.  
  28.  
  29.  
  30. UPGRADING
  31. ---------
  32.  
  33. Upgrading may require a partial or complete reconfiguration of your
  34. FileFind.cfg file. Please read these documents!!! 
  35.  
  36. If you are upgrading from V1.64 or lower, you MUST rebuild your config file.
  37. You can use the included sample configuration file as your guide.
  38.  
  39.  
  40.  
  41.  
  42. INSTALATION             *** FOLLOW THESE INSTRUCTIONS CAREFULLY ***
  43. -----------
  44.  
  45. NOTE: The address FileFind will expect to see in the OUTBOUND directory is
  46.       developed from your network address and the point address you supply!
  47.       For example. If your network address is 1:3406/32.31 (line #1 in the 
  48.       config) and you supply the point address 9999 (line #7 above), the 
  49.       address that FileFind will be expecting to receive mail at will be 
  50.       1:3406/32.9999 so that is the address you will export mail to and be 
  51.       sure to password protect the session level for that address.
  52.  
  53.  
  54.  
  55.  1) Define a session password for the site you have defined. I will use the
  56.     address 1:3406/32.9999 for example. (see note above)
  57.     You wouldn't want someone getting into your system under FileFind's
  58.     account. IE. SetPasswd 1:3406/32.9999 "<password>"
  59.  
  60.  2) Create an account for site 1:3406/32.9999 for exporting your desired echos
  61.     to. How you do this depends on what software you use. I am using XMAIL
  62.     to take care of this for me so I won't give an example here. Check your
  63.     manual/documentations for the program you use. Set the site name to
  64.     "Amiga FileFind". (remember, the actual address depends on your config)
  65.  
  66.  3) Have all mail that is sent to FileFind placed on HOLD or you will have
  67.     some problems.
  68.  
  69.  4) Make sure you have the packets archived with LHA in either .lha or .lzh
  70.     format. This is usualy done by your mail tosser/scanner program(s).
  71.  
  72.  5) Turn on the echos you want to have FileFind processing. Usualy this is
  73.     the echo FILEFIND in the Fido backbone. You can also set any other echos
  74.     you like. This may be other networks, or local nets only. What ever you
  75.     need. Any area you turn on will be monitored by FileFind.
  76.  
  77.  6) Place FileFind in any directory you like. Makes no differance. Just be sure
  78.     it can be accessed when you need it.
  79.  
  80.  7) Place FileFind.cfg in your S: directory. (MUST MUST MUST)
  81.  
  82.     Please check the sample config file for the proper syntax. The key words
  83.     in the config file may be in any order, but they must all be used in
  84.     order to get the proper function out of the program. Also, the lines that
  85.     are blank or start with a ; may be removed to save disk space.
  86.  
  87.  8) Create a banner to have added to the top of each out going message.
  88.  
  89.  9) Edit S:FileFind.cfg to fit your system's needs. There are comments in the
  90.     file. Just be sure that you don't have spaces in your paths or file names.
  91.     The first space will mark the end of the value and start the comments.
  92.  
  93. 10) If you are already registered, place FileFind.key in your S: directory.
  94.     This will unlock all the power of the program.
  95.  
  96.  
  97.  
  98.  
  99.  
  100. SPECIAL NOTES
  101. -------------
  102.  
  103. CNet/3      You must activate the TrimKludge key word in the config file
  104.  
  105.  
  106.  
  107.  
  108. SYSOP USAGE
  109. -----------
  110.  
  111. Have your CHRON program or aftersession script or both make a call to FileFind.
  112. Once activated, it will read the config file and take care of the rest.
  113.  
  114. Simply call "FileFind". You may need to specify the path if it is not in your
  115. system's normal search path.
  116.  
  117. FileFind sends text to the screen. If you want to create a log file, simply
  118. redirect the out put to your log file. IE: FileFind >>Logs:FileFind.log
  119. You may also have a seperate log file created by configuring the FileFind.cfg
  120. file. In this case, you can monitor calls to FileFind through the CLI and still
  121. get your information in the log file. When you have FileFind running
  122. automaticaly from a cron program or your aftersession program, you will most
  123. likely want to stop any output other than the log file. IE: FileFind <>NIL:
  124.  
  125. PLEASE NOTE: No log file will be created unless there is at least one message
  126.              addressed to one of FileFind's aliases.
  127.  
  128. To take advantage of the automated update fucntion of FileFind, or even the 
  129. notification and manual update function, you will need to be connected to the
  130. message echo "AMIGA_FILEFIND" through FidoNet. If this echo is not yet on 
  131. BackBone in your area as of yet, you may feed this one echo from my system
  132. 1:3406/32. It should be on the BackBone quite soon.
  133.  
  134.  
  135. Starting with V2.0 of FileFind, there are two special entries in the config
  136. file. They are AreaKey and AreaLag. With these two key words, you can have
  137. FileFind seperate the items matched by what file area they come from. For
  138. example....
  139.  
  140. Your file list looks something like this......
  141.  
  142.    Trumpet             21K 15/09/93 [01] instrument
  143.    voiceto1             0K 15/09/93 [01] instrument
  144.    WhipCrack           10K 15/09/93 [00] instrument
  145.    wistle              94K 15/09/93 [01] instrument
  146.    wistle-2            57K 15/09/93 [01] instrument
  147.    ==========================================================================
  148.    Total KB listed in this area : 1094
  149.  
  150.                                  [Audio-DMCS-Music]                               
  151.  
  152.    FileName          Size  Date     Dls  Description
  153.    ==========================================================================
  154.    1812ovr.LZH         69K 15/09/93 [02] 1812 overchier. Requires over 1 meg
  155.                                          and plays for 16+ minutes
  156.    Cheers.lzh           2K 15/09/93 [01] The toone from the TV show
  157.    empire.lzh         201K 15/09/93 [02] A nice version of the theme to
  158.                                          StarWars
  159.    gl0001.lzh           4K 15/09/93 [01] Gordon Lightfoot toone
  160.    mission.LZH          1K 15/09/93 [01] Mission Imposible
  161.    MusicBox.LZH         2K 15/09/93 [01] Musicbox Dancer
  162.    paperb.LZH           1K 15/09/93 [00] Paperback Writer by the Beetles
  163.    stairway.LZH        29K 15/09/93 [02] Stairway to Heaven.
  164.    ==========================================================================
  165.    Total KB listed in this area : 309
  166.  
  167.                                    [Audio-Effects]                                
  168.  
  169.    FileName          Size  Date     Dls  Description
  170.    ==========================================================================
  171.    Applause.snd        32K 04/04/94 [01] Some clapping
  172.    AREYOUSU.SND        44K 04/04/94 [02] HAL questioning you...
  173.    Attention.snd        8K 04/04/94 [03] Cylons from BattleStar Galactica ???
  174.  
  175. ....You would set your AreaKey and AreaLag like this....
  176.  
  177.    AreaKey     FileName          Size  Date     Dls  Description
  178.    AreaLag     2
  179.  
  180. ....And would get a file search something like this....
  181.  
  182.    toone   (6)
  183.    ==========================================================================
  184.    >[Audio-DMCS-Music]<
  185.    Cheers.lzh           2K 15/09/93 [01] The toone from the TV show
  186.    gl0001.lzh           4K 15/09/93 [01] Gordon Lightfoot toone
  187.  
  188.    >[Audio-MOD]<
  189.    mod.Ghostly        119K 03/09/93 [03] Scary sounds along with a  cool toone
  190.    mod.Popcorn         48K 27/08/93 [00] Very old toone
  191.    mod.prelude         21K 19/05/94 [00] Quite a moving toone. Lovely and 
  192.                                          soothing.
  193.  
  194.    >[Pics-General]<
  195.    Simpson.001         35K 22/08/93 [01] The entire zaney cartoone family!
  196.  
  197. ....You see, the matches are seperated out by the file area they were found
  198. in. This could make it much easier for users to locate the right files in
  199. your replys. There is little added text since the blank lines only require 
  200. one single character. And the area titles are useful and not a waste.
  201.  
  202. AreaKey is the text that identifies the area title is present. This must be
  203.         an exact match. Use as much text as you can to help prevent a mistake
  204.         being made. If you can only identify 10 or 20 characters that are
  205.         unique to the area name passing by, that may be enough.
  206.  
  207. AreaLag is the number of lines to go back to get the area name. This could be
  208.         0 (zero) in some cases, but it is usualy 1 or 2 lines before the
  209.         AreaKey text. In the example above, the area name was 2 lines before
  210.         AreaKey text show up in the file list. (see above)
  211.  
  212.  
  213.  
  214.  
  215. USER USAGE
  216. ----------
  217.  
  218. Please read the file "Help.FileFind" and make it available to your
  219. users so they will know how to use the program properly.
  220.  
  221.  
  222.  
  223.  
  224. NOTES
  225. -----
  226.  
  227. It is assumed that you already have a program for processing file requests and
  228. creating a list of files you have available for requesting.
  229.  
  230. If you do not, please get a copy before using FileFind. It is rude to say you
  231. have files to offer when you can't deliver them when they are requested.
  232.  
  233. Personaly I recommend QSilver for processing the file requests that come into
  234. your system. And Mercury for creating file lists. Both of these programs are
  235. available on my system and from the author "Roger Clark" at 1:382/105 on Fido.
  236.  
  237.  
  238.  
  239. Registration
  240. ------------
  241.  
  242. WHY?
  243.    Due to the fact that so many of my programs have gone unpaid for I decided
  244.    to try using a KEY file to increase the return on my efforts. This was not
  245.    easy to gather the required information and write the program.
  246.  
  247. WHAT DO I GAIN?
  248.    In the unregistered state, FileFind will only process one key word per
  249.    message. This will give you a lot of power, but many requests come through
  250.    with more than one key word. When you get the KEY file you will be able
  251.    to process up to 20 key words per request. This is a big help.
  252.  
  253. HOW MUCH?
  254.    I am asking $10.00 for the KEY file. This is not much for all the traffic
  255.    that FileFind can bring to your system. The more people who see your system
  256.    messages on the network, the more systems you will be called by.
  257.  
  258. WHAT DO YOU NEED TO KNOW?
  259.    When you decide to register, print and filling the form "FileFind.reg" and
  260.    it along with your payment and I will create a KEY file for you.
  261.    I will quickly send it out to you as you specify on the registration form.
  262.  
  263. WHAT ABOUT UPDATES?
  264.    Once you pay for one registered copy, you are entitled to unlimited upgrades
  265.    and replacement key files assuming you don't abuse the right by giving your
  266.    KEY to someone else or loose it over and over. (basicly, don't be a pest)
  267.  
  268. WHAT ARE MY RESPONSIBILITIES?
  269.    Your only responsibilities are to keep your KEY from getting onto other
  270.    systems, and do report any problems you encounter back to me. Other than
  271.    that the program is all yours.
  272.  
  273.  
  274.  
  275.  
  276. History
  277. -------
  278.  
  279. 1.0  FileFind comes to life!
  280.  
  281. 1.1  There seems to be a conflict in the IBM world with the name RAID
  282.      being used for file searching. I don't really care much about them,
  283.      but to be polite I suggest not using it any more. I have set FileFind
  284.      up to recognise the names ALLFIX and FILEFIND when reading through the
  285.      new mail. As before, FILEFIND is to be used when you only want Amiga
  286.      systems to respond to your requests.
  287.  
  288. 1.2  BUG FIX - Problem with TrapToss tossing second message in a mail packet
  289.                solved. Replies are now broken up into multiple packets.
  290.  
  291. 1.5  DEBUG command line option removed. No longer needed.
  292.      Cleaned up the look of the messages returned to the users by seperating
  293.      the various file search replys by keyword. Makes it easier to read.
  294.  
  295. 1.6  Added some features to make the file search more flexible and powerful
  296.      and allow more file list generator programs to be used.
  297.  
  298. 1.62 Added SEEN-BY: and PATH: lines to the end of each message to be more
  299.      compatible with some software.
  300.  
  301. 1.64 Added the ability to monitor the echos for update notices. You can have
  302.      FileFind notify you and then you manualy FREQ the updates, or you can
  303.      set FileFind up to automaticly FREQ the updates for you! (FidoNet only)
  304.  
  305. 2.0  Cleaned up the LOG file. Some people were being confused by the REPLY TO
  306.      and FROM lines. They were ment to be the message headers of the replys,
  307.      but are now reversed. They are the message headers of the incoming mail.
  308.      Also, no log will be created unless there is at least one message 
  309.      addressed to the FileFind program. (any of it's aliases)
  310.  
  311.      Also, LHA will no longer report an error if there is nothing to unarchive.
  312.      This is now replaced with a nice little message saying NOTHING TO UNPACK.
  313.      
  314.      The config file has been totaly rebuilt. You can now change your ORIGIN
  315.      line any time you like as long as you have a registered version of the
  316.      program. Otherwise the changes you make are ignored.
  317.      
  318.      Reformatted the origin line to be inline with 99% of the other programs
  319.      out there. Your address is the last thing on the origin line now not
  320.      right after the word ORIGIN.
  321.  
  322.      The output in the reply messages are now exactly like they are in your
  323.      banner and list files. The case of the text is no longer forced to lower.
  324.  
  325.      Pilicy change: Replacement key files will be given as long as there is
  326.                     a just cause. And the privladge is not abused. (free)
  327.                     Abusers must pay for new keys (if they deserve one at all)
  328.  
  329.                     Upgrades will be given freely to all users. I will send
  330.                     you one at the time of your registration. After that you
  331.                     need to download it yourself. Or have FileFind FREQ it.
  332.  
  333.      You can now have FileFind skip or filter out junk text such as
  334.      "No Description Available" to help prevent the wast of phone time and
  335.      disk space.
  336.  
  337.      You can now have FileFind use your main address when replying (normal)
  338.      or have it use it's own point address. Some systems didn't like mail
  339.      coming from the same address as it was addressed to import on. boo hoo!
  340.  
  341.      You can now have FileFind seperate items by what file area they come from
  342.      by using AreaLag and AreaKey in the config file. (see above for info)
  343.  
  344.  
  345.  
  346.  
  347. *** NEXT ***
  348.  
  349. One system has requested an option to send replys via NETMAIL or ROUTEMAIL
  350. and not EchoMail. If other systems like this option, I will add it to the
  351. program. If no one else asks for it, I won't add it.
  352.  
  353. If I do add this, it will be sysop selectable in the config file.
  354.  
  355.  
  356.  
  357.  
  358. Distribution
  359. ------------
  360.  
  361. DO NOT rename or convert this archive! Leave it as FILEFIND.LZH please.
  362.  
  363. This program may be freely distributed as long as the files are not 
  364. altered in any way other than the methode of archival. There must be no 
  365. fees charged for this program other than the minimal copying fee normaly 
  366. charged by user groups. This program may be added to any disk collections 
  367. such as Fred Fish.
  368.  
  369.  --- NO WARRANTY EXPRESSED OR IMPLIED. USE THIS AT YOUR OWN RISK ---
  370.  
  371.